home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / 4dostool / bkup10.zip / BKUP.DOC < prev    next >
Text File  |  1994-05-18  |  17KB  |  340 lines
  1.  A DESCRIPTION OF BKUP.BTM
  2.  (May 16, 1994)
  3.  
  4.  BKUP.BTM transports files between computers. It can also be used
  5.  for quick 'maintenance of disk' (like deleting unnecessary files).
  6.  
  7.  Since version 10, BKUP no longer supports 4DOS prior to 5.x. Use
  8.  BKUP version 8 instead.
  9.  
  10.  BKUP.BTM is written in 4DOS batch language. 4DOS is a registered
  11.  trademark and copyrighted property of JP Software, Inc. For other
  12.  copyrighted programs see below, "Copyrighted programs".
  13.  
  14.  
  15.  CREATING A COMPRESSED FILE FOR NEW (UPDATED) FILES
  16.  ==================================================
  17.  BKUP.BTM creates a list of files saved on specified disk (default is
  18.  default [boot] drive) either [a] today, or [b] since a specified number of
  19.  days back, or [c] since a specified date.
  20.  
  21.  The list of files can be edited in various ways, leaving on it only those
  22.  files you wish to transport to your other computer(s).
  23.  
  24.  When the list editing is done, BKUP.BTM runs a compressor to create an
  25.  archive on specified drive (default is B:), with the specified date as a
  26.  name (for example, 3-26-93.ZIP). If such an archive already exists, it is
  27.  updated with new versions, or new files, if detected in the list. BKUP
  28.  can run 3 compressors: PKZIP, ZIP, and UC2. However, there are a few
  29.  limitations on using ZIP and UC2 for some options (see below, "Usage
  30.  Notes and Limitations").
  31.  
  32.  The files are archived with pathnames. This means that they will be
  33.  extracted on the target computer to the same subdirectories where they
  34.  were created on the source computer. By default, files are extracted to
  35.  the default (boot)  drive, unless otherwise specified. If a subdirectory does not
  36.  exist on the target computer, it is created by the extraction program
  37.  during extracting.
  38.  
  39.  The archive is marked with the description "Updated from: name", where
  40.  "name" stands for an actual "name" given to your computer (see below,
  41.  "'Names' for computers and diskettes".
  42.  
  43.  EXTRACTING THE UPDATED FILES FROM THE ARCHIVE TO THE OTHER
  44.  COMPUTER(S)
  45.  ==========================================================
  46.  To extract the archived file(s), use the -x (or /x, or x) switch.
  47.  BKUP.BTM can run 3 extractors: PKUNZIP, UNZIP, and UC2. However,
  48.  there are a few limitations on using ZIP and UC2 for some options (see
  49.  below, "Usage Notes and Limitations").
  50.  
  51.  If there is more than one archive on your diskette, BKUP lets you select
  52.  the one(s) you wish to extract. Extracted files (archives) are marked with
  53.  the description "Extracted to: name; name; ...", where "name" stands for
  54.  the actual "name" of your computer (see below, "'Names' for computers and
  55.  diskettes"). If you try to extract the archive again to the same computer,
  56.  you will be told that it was already extracted, and will be asked to
  57.  decide to either "force extract" it, delete the archive file from disk, or
  58.  quit. If you do not respond, BKUP will leave the archive intact and go on
  59.  after 3 seconds to treat the next one. If in doubt, don't hesitate to use
  60.  the "force extract" option, because all extractors will not overwrite
  61.  files on your disk unless the matching files stored in the archive are
  62.  newer.
  63.  
  64.  If the archive was extracted, but then was updated again with new versions
  65.  or files (this is normal if both updating and extraction are done the same
  66.  day, or for the same date), it will be marked with the description "Updated
  67.  from: name", to allow subsequent extractions as well as indicate the source
  68.  of the new files (i.e., the computer on which they have been created).
  69.  
  70.  The extraction utility pops up a menu of archive files, even if only
  71.  one such archive exists. If more than one archive exists, you can mark
  72.  those you wish to extract (by pressing the spacebar at the relevant
  73.  filename).
  74.  
  75.  EDITING THE LIST OF FILENAMES
  76.  (before compression)
  77.  =============================
  78.  When the list of all the relevant files is created, BKUP.BTM lets you
  79.  select one of the following options:
  80.  
  81.  (*) View (and handle) filenames on screen, one by one
  82.  (*) Use an editor to edit results (results file)
  83.  (*) View results before making any decision
  84.  (*) Go immediately to archiving (no selection)
  85.  (*) Quit (results file will remain intact)
  86.  If you choose viewing (and handling) files on screen, the following
  87.  options are then available while working:
  88.  
  89.  (*) Accept or omit a file (from the list)
  90.  (*) View a file before making a decision about it
  91.  (*) Delete a file from disk (after or before viewing)
  92.  (*) Stop selecting and begin archiving immediately
  93.  (*) View the list of selections at each step
  94.  (*) Quit (results file will remain intact)
  95.  
  96.  CONFIGURING BKUP
  97.  ================
  98.  BKUP can be configured by BKUP.INI. This file can easily be edited
  99.  with any editor. However, the primary parameters and options defined in
  100.  BKUP.INI can be overridden from the command line. Alternatively, aliases
  101.  can be used to avoid editing BKUP.INI. If BKUP.INI is missing or the user
  102.  prefers not to have it, and the user does not provide any commands on the
  103.  command line, BKUP will use its internal defaults.
  104.  
  105.  The PRIMARY defaults (for both compressing and extracting) are:
  106.  (replaceable from the command line)
  107.  
  108.  (1) Disk from which files will be compressed - default (boot) drive
  109.  (2) Drive where archive will be created      - B:
  110.  (3) Disk to which files will be extracted    - default (boot) drive
  111.  (4) Drive where archive will be looked for   - B:
  112.  (5) Compression and extraction programs:     - PKZIP and PKUNZIP
  113.  (6) Date for files to be updated:            - today
  114.  (7) Exclude files:                    -  *.zip *.bak *.tmp *.log *.uc2
  115.  
  116.  The SECONDARY defaults (for both compressing and extracting) are:
  117.  (NOT replaceable from the command line, but BKUP will request you
  118.  to make decisions for options (8)-(11) if BKUP.INI is missing, or
  119.  if they are not defined in BKUP.INI. Option 12 can be defined only
  120.  in BKUP.INI or in the BKUP.BTM file itself.)
  121.  
  122.  (8)  Checking the name of updates diskette     - yes
  123.  (9)  Name of updates diskette                  - "transmit"
  124.  (10) Name of search and extract drives         - computer's label
  125.  (11) Text editor to be used                    - t.com
  126.  (12) Colors of final message     - bright white & black on white;
  127.  
  128.  Therefore, if you just type "BKUP", this is equal to typing:
  129.  
  130.  (compressing:) BKUP c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  131.     (+ secondary defaults)
  132.     or
  133.  (extracting:)  BKUP -x c: b: 0 /pkzip /x *.zip *.bak *.tmp *.log *.uc2
  134.     (+ secondary defaults)
  135.  
  136.  "NAMES" FOR COMPUTERS AND DISKETTES
  137.  ===================================
  138.  BKUP is set to use the labels of your "search disk" and "extract disk"
  139.  (both of which would normally be your default [boot] drive) as "names" for
  140.  your computer. This makes it possible to know which of your computers
  141.  has/have been updated, and to which computers the archive has been
  142.  extracted (if there are more than one archive, BKUP will add all of
  143.  their names when the archive was extracted).
  144.  
  145.  You can change this default by entering a different name for your
  146.  computer at the 'compuname=' line in BKUP.INI.
  147.  
  148.  If your default (boot) drive has been given no label, BKUP will prompt you
  149.  to give your computer a temporary name for the current session. You
  150.  can make this "name" permanent by labeling your hard disk or typing
  151.  a name at the 'compuname=' line in BKUP.INI.
  152.  
  153.  BKUP can also be set to check the "name" (i.e., label) of the diskette
  154.  inserted into the "archive drive". If you prefer to always use the same
  155.  diskette for transporting files between your various computers, this
  156.  is the best solution for keeping all of the update archives on one
  157.  device. By default, the name of the update diskette is "TRANSMIT". You
  158.  can change the name at the 'updatedr=' line in BKUP.INI. Also, you may
  159.  cancel this option altogether by typing 'no' at the 'updatename=' line.
  160.  If this line is not defined, or BKUP.INI is missing, BKUP will prompt
  161.  you at the relevant moment to enter a name for the updates diskette.
  162.  If the diskette inserted into the drive is not the dedicated one,
  163.  BKUP will ask yo